PayPal決済都度決済＋利用承諾 API一覧

PayPal決済　都度決済＋利用承諾 API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

EntryTranPaypal 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
JobCd		必須半角英字8桁処理区分 CAPTURE：即時売上 AUTH：仮売上
Amount		必須半角数字記号10桁利用金額小数点（第二位まで）を含む桁数です。
Tax		半角数字記号10桁税送料税送料を指定した場合は、利用金額+税送料が決済金額となります。小数点（第二位まで）を含む桁数です。
Currency		半角英字3桁通貨コード省略時：JPY（日本円）

URL

/payment/EntryTranPaypal.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=100

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranPaypal 決済実行

PayPalと通信を行い決済要求結果を返します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
ItemName		必須全半角記号64桁商品・サービス名
RedirectURL		必須半角英数記号200桁リダイレクトURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを指定します。 PayPal上でお客様が認証、支払操作をキャンセルした場合や、当サービスにて決済処理を実行した場合に指定されたURLに結果を送信します。結果はリダイレクト経由で送信します。
PaymentType		必須半角英字10桁決済タイプ下記を設定します。 REGISTER：都度決済+利用承諾をする
Locale		半角英字2桁言語 PayPal決済画面上に表示する言語を選択します。無指定の場合、日本語が表示されます。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
ClientFieldFlag		半角数字1桁固定加盟店自由項目返却フラグ以下のいずれかを設定します。 0：返却しない(デフォルト) 1：返却する
ShipFlg		半角数字1桁固定配送先利用フラグ以下のいずれかを設定します。「1」を指定した場合、配送先情報を設定してください。 0：利用しない(デフォルト) 1：利用する
ShipToName		全半角256桁配送先氏名・配送先利用フラグが1の場合は必須です。・半角英数記号（除く ^`{\|}~&<>'）と全角文字が使用可能が使用可能です。・名、姓の順番で、間に半角スペースを挟みます。例）太郎山田
ShipToZip		半角英数記号20桁配送先郵便番号配送先利用フラグが1の場合は必須です。・半角英数記号（記号は-「ハイフン」のみ）が使用可能です。例）0030001
ShipToCountryCode		半角英字2桁配送先国コード・ISO-3166-1に基づく、国コードを設定します。・配送先利用フラグが1の場合は必須です。・半角英字が使用可能です。例）JP
ShipToState		半角英数記号40桁配送先都道府県・配送先利用フラグが1の場合は必須です。・半角英数記号（記号は-「ハイフン」のみ）が使用可能です。例）TOKYO-TO ・下記URL記載の国の場合はPayPal州コードを入力してください。 ■Paypal州コード一覧 https://developer.paypal.com/docs/nvp-soap-api/state-codes/
ShipToCity		半角英数記号40桁配送先市町村・配送先利用フラグが1の場合は必須です。・半角英数記号（記号は-「ハイフン」のみ）が使用可能です。例）shibuya-ku
ShipToStreet		半角英数記号100桁配送先番地・配送先利用フラグが1の場合は必須です。・半角英数記号（記号は-「ハイフン」のみ）が使用可能です。例）dogenzaka1-99-999
ShipToStreet2		半角英数記号100桁配送先建物名など・配送先利用フラグが1の場合は必須です。・半角英数記号（記号は-「ハイフン」のみ）が使用可能です。例）shibuya-sample-building

URL

/payment/ExecTranPaypal.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&ItemName=商品名&RedirectURL=https://example.com/receive&PaymentType=REGISTER

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PaypalStart 支払手続き開始

お客様をPayPalの認証画面へと遷移させる必要があります。
加盟店様はリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。
当サービスは各種パラメータを設定し、お客様をPayPalの認証画面に誘導します。
※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト

ShopID		必須半角英数13桁ショップID
AccessID		必須半角英数32桁固定取引ID

URL

/payment/PaypalStart.idPass

リダイレクトページサンプル

<html>
      <head>
      <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
      </head>
      <body OnLoad='OnLoadEvent();'>
      <form name="PaypalStartCall" action="{支払手続き開始URL}" method="POST">
        <noscript>
          <br>
          <br>
          <center>
            <h2>PayPalの決済画面へ遷移します。</h2>
            <input type="submit" value="続行">
          </center>
        </noscript>
        <input type="hidden" name="ShopID" value="{ShopID}">
        <input type="hidden" name="AccessID" value="{AccessID}">
      </form>
      <script>
    <!--
    function OnLoadEvent() {
    document.PaypalStartCall.submit();
    }
    //-->
      </script>
      </body>
    </html>

リダイレクト後、お客様はPayPalログイン画面へ遷移します。

決済結果受信

PayPalからリダイレクト経由で、当サービスに支払操作結果が通知されます。

レスポンス

正常

ShopID		半角英数13桁ショップID
OrderID		半角英数記号27桁オーダーID
Status		現状態対象取引の取引状態を返却します。・AUTH：仮売上・CAPTURE：即時売上・PAYFAIL：決済失敗
TranID		半角英数19桁トランザクションID PayPalから返却された処理番号を返却します。
TranDate		半角数字14桁固定処理日時 yyyyMMddHHmmss書式
PaypalBillingAgreementID		半角英数記号19桁支払同意ID PayPalから返却された支払同意IDを返却します。
AgreementCurrentstatus		半角英字8桁利用承諾現状態利用承諾の現状態を返却します。・REGISTER：利用承諾・FAIL：申込失敗

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&OrderID=ORDER0000001&Status=AUTH&TranID=6KP06027ED30547N9&TranDate=20220801121212&PaypalBillingAgreementID=B-53G467521V0468537&AgreementCurrentstatus=REGISTER

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PaypalSales 実売上

PayPalと通信を行い取引の実売上処理を行います。 ※実売上を行うときは金額を変更することが可能です。変更後の合計金額は、変更前の合計金額より少なくしてください。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
Amount		必須半角数字10桁利用金額税送料を指定した場合は、合計利用金額が売上確定となります。仮売上時の合計利用金額を超える金額は指定できません。仮売上時の合計利用金額に満たない金額を指定した場合、差額はキャンセルされます。（一部実売上の例）　仮売上時の利用金額 = 1000円　指定する利用金額＝ 800円上記の条件で実売上を行った結果　売上金額 = 800円　キャンセル金額 = 200円
Tax		半角数字10桁税送料

URL

/payment/PaypalSales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=100

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
TranID		半角英数19桁トランザクションID PayPalから返却された処理番号を返却します。
TranDate		半角数字14桁固定処理日時 yyyyMMddHHmmss書式
Status		現状態通常：SALES 仮売期限切れ：PAYFAIL
Amount		半角数字記号10桁利用金額小数点（第二位まで）を含む桁数です。
Tax		半角数字記号10桁税送料小数点（第二位まで）を含む桁数です。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&TranID=6KP06027ED30547N9&TranDate=20201225091313&Status=SALES&Amount=100&Tax=8

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

CancelAuthPaypal 仮売上取消

PayPalと通信を行い、取引の仮売上取消処理を行います。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID

URL

/payment/CancelAuthPaypal.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
TranID		半角英数19桁トランザクションID PayPalから返却された処理番号を返却します。
TranDate		半角数字14桁固定処理日時 yyyyMMddHHmmss書式
Status		現状態成功時：AUTH_CANCEL

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&TranID=6KP06027ED30547N9&TranDate=20201225091313&Status=AUTH_CANCEL

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

CancelTranPaypal キャンセル

PayPalと通信を行い、取引のキャンセル処理を行います。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
OrderID		必須半角英数記号27桁オーダーID
Amount		必須半角数字記号10桁利用金額小数点（第二位まで）を含む桁数です。
Tax		半角数字記号10桁税送料小数点（第二位まで）を含む桁数です。

URL

/payment/CancelTranPaypal.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=100

レスポンス

正常

OrderID		半角英数記号27桁オーダーID
TranID		半角英数19桁トランザクションID PayPalから返却された処理番号を返却します。
TranDate		半角数字14桁固定処理日時 yyyyMMddHHmmss書式

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

OrderID=ORDER0000001&TranID=6KP06027ED30547N9&TranDate=20201225091313

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
PayType		必須半角数字2桁決済方法 5：PayPal決済

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=5

レスポンス

正常

Status		現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 AUTH_CANCEL：仮売上取消 CANCEL：キャンセル PAYFAIL：決済失敗 EXPIRED：期限切れ
ProcessDate		半角数字14桁固定処理日時 yyyyMMddHHmmss書式
JobCd		処理区分 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 AUTH_CANCEL：仮売上取消 CANCEL：キャンセル END：利用終了
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード
Amount		半角数字記号7桁利用金額
Tax		半角数字記号7桁税送料
Currency		半角英字3桁通貨コード
TranID		半角英数28桁トランザクションID PayPalから返却された処理番号を返却します。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
PayType		半角数字2桁決済方法 5：PayPal
PaypalPaymentType		半角英字10桁決済タイプ REGISTER：都度決済+利用承諾
PaypalAgreementCurrentstatus		利用承諾現状態利用承諾の現状態を返却します。 UNPROCESSED：未決済 REQSUCCESS：要求成功 REGISTER：利用承諾 END：利用終了 FAIL：申込失敗
PaypalAgreementID		半角英数記号19桁支払同意ID PayPalから返却された支払同意IDを返却します。
PaypalBillingAgreementID		随時決済用支払同意ID nullで返却します。
PaypalAgreementStartDate		半角数字14桁固定利用承諾日付 yyyyMMddHHmmss書式
PaypalAgreementEndDate		半角数字14桁固定利用終了日付 yyyyMMddHHmmss書式

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=AUTH&ProcessDate=20201225091313&JobCd=AUTH&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=8&Currency=JPY&TranID=6KP06027ED30547N9&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=5&PaypalPaymentType=REGISTER&PaypalAgreementCurrentstatus=REGISTER&PaypalAgreementID=B-1YL66913SV546823C&PaypalBillingAgreementID=&PaypalAgreementStartDate=20201225091313&PaypalAgreementEndDate=

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

PayPal決済